authentication-services-colmena
API Dictionary
Dictionary
This section provides a comprehensive glossary of terms and definitions used throughout the API documentation. It is designed to clarify technical concepts and ensure a better understanding of the API's functionality.
Terms
| Term | Definition |
|---|---|
| accessToken | A token generated to authenticate requests to other services. |
| expiresIn | The lifespan of the token, measured in milliseconds or seconds. |
| refreshToken | A token used to renew the accessToken without the need to request credentials again. |
| clientId | A unique identifier assigned to a registered application for accessing the API. |
| clientSecret | A secret key associated with the clientId to authenticate the application. |
| grantType | The method used to obtain the token. Example: authorizationCode or clientCredentials. |
| authorization | An HTTP header containing the access token to perform authenticated requests. |
| scope | Permissions or access levels associated with a token. Example: full or offlineAccess. |
| authorizationCode | A temporary code issued during the authorization flow to obtain an access token. |
| bearerToken | A type of token that allows access to protected resources via the Authorization header. |
You can integrate this dictionary as a quick reference guide while exploring the API's endpoints and parameters. It ensures consistency and aids in better understanding of key elements and processes.